Skip to main content
Version: 24.03

Specification

Certificate Management kit banner

Certificate Management KIT

API Reference

The Certificate Management contains a variety of different APIs, and with the help of Swagger UI interface, which is an interactive tool for exploring and testing RESTful APIs, those can easily be used. Swagger UI provides a user-friendly interface for interacting with APIs, allowing you to make requests, view responses, and explore different API endpoints and operations, allowing you to drill down into specific endpoints and view the associated request parameters, response schemas, and sample responses.

The Certificate Management includes core services for querying and adding certificate data for business partner base information in the Eclipse Tractus-X landscape. In the following sections, the available methods and different controllers of the API are explained. More Information to the open-source repository can be found on GitHub

Certificate Management Api references

Available Methods

Request MethodRequest Description
POSTSubmit data to be processed
GETRetrieve data searching for the best match

1. Certificate Controller

The Certificate Controller is the controller that creates, and retrieves various certificates via BPN, Type or DocumentID. The POST and GET endpoints
available under Certificate controller are clustered in table below. Hyperlink in each record gives you more information about api endpoint.

Certificate Controller Apis
Provide a specific certificate document for a given BPN
Get all certificates of a given BPN
Get a specific certificate by certificate type and a given BPN
Gets info whether BPN is certified for a specific certificate type
Request certificate document for given document id

2. Metadata Controller

The Metadata Controller is mainly used for registering and retrieving certificate types. There is one GET and a POST. These are available under Metadata controller and are clustered in table below. Hyperlink in each record gives you more information about api endpoint.

Metadata Controller Apis
Register a new certificate type
Get a list of all currently registered certificate types